Skip to content

Standardize TASC document structure, metadata, and numbering conventions#76

Open
mamanambiya wants to merge 13 commits intoga4gh:mainfrom
mamanambiya:master
Open

Standardize TASC document structure, metadata, and numbering conventions#76
mamanambiya wants to merge 13 commits intoga4gh:mainfrom
mamanambiya:master

Conversation

@mamanambiya
Copy link
Copy Markdown
Collaborator

@mamanambiya mamanambiya commented Oct 28, 2025

Summary

This PR formalizes TASC document standards based on the Placement Proposal presented in February 2026.

What's included

Document Numbering Convention

  • GA4GH-REC-XX for recommendations (e.g., GA4GH-REC-01)
  • TASC-GOV-XX for governance documents (e.g., TASC-GOV-01)
  • TASC-ADR-XXX for Architectural Decision Records (e.g., TASC-ADR-001)

Metadata Templates

  • Recommendation template with standardized header fields: Source, Recommendation ID, Title, Related GitHub Issues, Raised by, Authors, Date, Status, Keywords, Work Streams Impacted, Products Affected
  • ADR template with: Date, Status, Deciders, Keywords, Work Streams Impacted, Products Affected

Recommendations (4)

  1. GA4GH-REC-01: API Pagination Guide - Standardizes token-based and page-based pagination approaches
  2. GA4GH-REC-02: Service Info Type Registry Guide - Defines governance for service type registry
  3. GA4GH-REC-03: GA4GH Product Owners - Establishes Product Owner role and software product management principles
  4. GA4GH-REC-04: TASC Technical Specification Development - Defines four-level maturity model and release processes

Governance (2)

  • TASC-GOV-01: TASC Governance and Leadership Charter - Updated with standardized metadata
  • TASC-GOV-02: TASC Document Standards (Draft) - Formalizes format, placement, and communication standards for all TASC outputs

Repository Structure

  • Added /adr/ directory with template
  • Added /governance/ directory for TASC governance documents
  • Organized existing and new recommendations in /recommendations/
  • Updated README.md with repository structure documentation
  • Added .markdownlint.yml for consistent Markdown linting
  • Updated .gitignore to exclude working data, drafts, and tooling files

Not included (planned for separate PR)

  • ADR documents 001-007 (will be submitted separately)

Test plan

  • Verify all recommendation metadata headers are consistent with the template
  • Verify governance doc metadata headers are consistent
  • Verify ADR template matches the proposed Nygard format
  • Verify numbering convention is applied consistently
  • Verify all internal links resolve correctly

Ignore the data directory containing working CSV files that should not be version controlled.
- Add GA4GH-02 recommendation for service type registry governance
- Include standardized metadata header with GitHub issues
- Add abstract and contributors sections
- Update table of contents to show first-level headings only
- Add GA4GH-03 recommendation for Product Owner role definition
- Include standardized metadata header with GitHub issues
- Add abstract and contributors sections
- Establish software product management principles for GA4GH standards
- Add GA4GH-04 recommendation for maturity model and release process
- Define four-level maturity framework (Draft, Trial Use, Normative, Deprecated)
- Include standardized metadata header with GitHub issues
- Add abstract and contributors sections
- Establish versioning and advancement criteria
- Add governance charter defining TASC structure and operations
- Include standardized metadata header with GitHub issues
- Add abstract and contributors sections
- Define voting membership, decision-making process, and operational procedures
- Add 7 ADRs documenting key technical decisions from TASC Technical Specification Development policy
- ADR-001: Adopt four-level maturity model (Draft/Trial Use/Normative/Deprecated)
- ADR-002: Require two implementations for Trial Use advancement
- ADR-003: Constrain child class maturity to parent class level
- ADR-004: Use semantic versioning with maturity-based rules
- ADR-005: Annotate maturity in JSON Schema
- ADR-006: Require 70% approval for community ballot advancement
- ADR-007: Allow SemVer pre-release syntax for continuous development
- Include ADR template and README index
- Add Repository Structure section to table of contents
- Add directory tree visualization showing all folders
- Add descriptions for /adr/, /governance/, /recommendations/, /drafts/, /service-info/
- Cross-reference to adr/README.md for ADR details
- Update ADR link to point to local adr/ directory
Provides a consistent structure for new TASC recommendations,
mirroring the existing ADR template convention.
…governance doc

- Update numbering convention: GA4GH-REC-XX for recommendations, TASC-GOV-XX
  for governance, TASC-ADR-XXX for ADRs
- Add metadata fields to templates and existing docs: Raised by, Keywords,
  Work Streams Impacted, Products Affected
- Add TASC-GOV-02 Document Standards governance doc formalizing format,
  placement, and communication standards for all TASC outputs
- Add .markdownlint.yml config for prose-friendly linting
- Update .gitignore for drafts/, .claude/, CLAUDE.md, .git.nosync/
@mamanambiya mamanambiya changed the title Add TASC repository structure with recommendations, ADRs, and governance documentation Standardize TASC document structure, metadata, and numbering conventions Mar 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant